home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / src / exampleCode / viewkit / xcontact / onlineHelp / README.SGIHELP < prev    next >
Encoding:
Text File  |  1994-08-02  |  5.2 KB  |  112 lines
  1.  
  2.     THIS FILE IS IDENTICAL TO THE ONE IN THE toolbox/utilities/sgihelp_dev
  3.     DIRECTORY.  PLEASE LOOK THERE FOR THE COMPLETE CONTENTS OF WHAT THIS 
  4.     DESCRIBES.
  5. _______________________________________________________________________________
  6.  
  7.                 ~4Dgifts/toolbox/utilities/sgihelp_dev README
  8.  
  9.                         the SGI Help Developer's Kit
  10.  
  11.     By now you have seen IRIS InSight and the SGIHelp system that released
  12.     on IRIX 5.2.  You've probably played around with some of the apps and
  13.     pulled down that "Help" menu that sits on the far right side of the
  14.     application and seen the help that is available.  You probably said
  15.     "Cool!!! this is great!" and now you want to add that same functionality
  16.     to your own apps.  Well look no further cuz now you can.  Simply install
  17.     the sgihelp_dev images on your machine, add the few library calls to
  18.     your application, and build the help book for your application.  Then
  19.     you just need to give your app and the inst images of the help book that
  20.     gets created to your customers and now you have SGIHelp integrated into
  21.     your application.  To begin this adventure follow the steps below to
  22.     install the tools and look at an example application that demonstrates
  23.     the complete process for integrating help with an application and
  24.     creating inst images of the help and application.
  25.     
  26.     What does SGIHelp give me, you might ask.  Well for one it integrates
  27.     context sensitive help and task based help into your application in
  28.     a seamless manner that makes your app look like any other SGI application.
  29.     In your help you can have lots of different organizational constructs
  30.     like ordered lists, notes warnings, figures, and a slew of other
  31.     structures.  All these structures are supported via SGML (Standard
  32.     Generalized Markup Language) which increases document portability since it
  33.     is an ISO standard known around the world.  There are also other viewers
  34.     on other platforms that can view this same SGML content - so when you port
  35.     your application to another platform you don't have to rewrite all your
  36.     help any more.  
  37.     
  38.     To extract the images off the CD issue the following command:
  39.     
  40.         inst -f ~4Dgifts/toolbox/utilities/sgihelp_dev
  41.         or 
  42.         inst -f /CDROM/utilities/sgihelp_dev
  43.         or 
  44.         inst -f /cdrom/utilities/sgihelp_dev
  45.         etc.
  46.     
  47.     The image installs a little over 2M of data and executables onto your
  48.     disk.  Contained in this are two samples - one is an example program
  49.     that has help integrated into it, and the other is a sample of the
  50.     various structures you can create in the help content for your
  51.     application.
  52.     
  53.     OK, now that you've extracted the files off the CD, what do you do
  54.     next.  We have included three sample examples in this developer package.
  55.     The first example shows a complete X11/Motif application that
  56.     integrates the library calls and helpmap file with the SGML help file.
  57.     This example is in /usr/share/Insight/XHELP/samples/exampleApp.
  58.     
  59.     This would be a good place for you to begin. Tools have been provided
  60.     that will allow you to completely build and test this example. To
  61.     perform that operation, do the following:
  62.     
  63.             % cd /usr/tmp
  64.             % cp -r /usr/share/Insight/XHELP/samples .
  65.             % cd samples/exampleApp
  66.             % make 
  67.     
  68.                     // This will build the application, and the help book
  69.     
  70.             % make images
  71.     
  72.                     // This will build the inst images for the application,
  73.                     // and the help book
  74.     
  75.             % su
  76.             # inst -f images
  77.             # exit
  78.     
  79.                     // This will install the inst image in the proper
  80.                     // location on the disk
  81.     
  82.             % ./exampleAppXm
  83.     
  84.                     // This will run the example application, try items off
  85.                     // the help menu...the SGIHelp server should start up
  86.                     // and render help cards relating to this application
  87.                     // from the help book that was created/installed in
  88.                     // the previous steps.
  89.     
  90.     
  91.     The second example demonstrates the various SGML structures that are
  92.     valid when constructing a SGML instance of the XHELP DTD.  This sample
  93.     file is in /usr/share/Insight/XHELP/samples/sampleDoc. When preparing
  94.     your help book it may be useful to examine this file, and cut & paste
  95.     desired elements from the sample into your own text, modifying content
  96.     where needed.
  97.     
  98.     The third example happens to be a document that describes the elements
  99.     available in the XHELP DTD, using the XHELP DTD.  When preparing your
  100.     help book this document may be useful to determine which tags should
  101.     be used at which parts of the document structure.  This document
  102.     can also help you fix errors in your document when you encounter
  103.     illegal structures.
  104.     
  105.     There is a document called HELPDEV.txt in /usr/share/Insight/XHELP that
  106.     discusses how to integrate help with your application in more detail.
  107.     Please read that file to begin your adventure of integrating SGIHelp
  108.     into your application.
  109.     
  110.     Good luck and welcome to the world of SGIHelp.
  111.     
  112.